Skip to main content
POST
/
agents
/
Create Agent
curl --request POST \
  --url https://agent-prod.studio.lyzr.ai/v3/agents/ \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{
  "name": "<string>",
  "system_prompt": "<string>",
  "description": "<string>",
  "features": [
    {
      "type": "<string>",
      "config": {},
      "priority": 123
    }
  ],
  "tools": [
    "<string>"
  ],
  "llm_credential_id": "<string>",
  "provider_id": "<string>",
  "model": "<string>",
  "top_p": 123,
  "temperature": 123,
  "response_format": {}
}'
{
  "id": 12345,
  "message": "Agent created successfully."
}

​
Endpoint:

POST /v3/agents/

​
Description:

Creates a new agent with a specific configuration.

​
Request Headers:

HeaderTypeRequiredDescription
x-api-keyStringYesAPI key for authentication
acceptStringYesExpected response format (application/json)
content-typeStringYesFormat of request body (application/json)

​
Request Body:

{
  "name": "string",
  "system_prompt": "string",
  "description": "string",
  "features": [
    {
      "type": "string",
      "config": {},
      "priority": 0
    }
  ],
  "tools": ["string"],
  "llm_credential_id": "string",
  "provider_id": "string",
  "model": "string",
  "top_p": 0,
  "temperature": 0,
  "response_format": {}
}

​
Request Example (cURL):

curl -X POST "https://agent-prod.studio.lyzr.ai/v3/agents/" ^
-H "accept: application/json" ^
-H "content-type: application/json" ^
-H "x-api-key: sk-default-XXXXXXX" ^
-d "{\"name\":\"string\",\"system_prompt\":\"string\",\"description\":\"string\",\"features\":[{\"type\":\"string\",\"config\":{},\"priority\":0}],\"tools\":[\"string\"],\"llm_credential_id\":\"string\",\"provider_id\":\"string\",\"model\":\"string\",\"top_p\":0,\"temperature\":0,\"response_format\":{}}"

​
Example Agent Configuration:

{
  "api_key": "sk-default-XXXXXXX",
  "template_type": "single_task",
  "name": "Nutrition Expert",
  "description": "Personalized Nutrition Assistant",
  "agent_role": "You are a NUTRITION EXPERT...",
  "agent_instructions": "Your task is to assist users in optimizing their diet...",
  "examples": null,
  "features": [
    {
      "type": "SINGLE_TOOL_CALL",
      "config": {
        "module_mode": "Post"
      },
      "priority": 0
    }
  ],
  "tool": "notion",
  "tool_usage_description": "Provide dietary plans and nutrition advice in a structured format.",
  "response_format": null,
  "provider_id": "OpenAI",
  "model": "gpt-4o-mini",
  "top_p": 0.9,
  "temperature": 0.7,
  "version": "3",
  "llm_credential_id": "lyzr_openai"
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
name
string
required
​
system_prompt
string
required
​
description
string
required
​
features
object[]
​
tools
string[]
​
llm_credential_id
string
​
provider_id
string
​
model
string
​
top_p
number
​
temperature
number
​
response_format
object

Response

Agent created successfully

​
id
string
Example:

12345

​
message
string
Example:

"Agent created successfully."